Skip to content

Include diagnostics in failed SARIF if they were created before a database was initialised - #4223

Open
mbg wants to merge 14 commits into
mbg/reduce-config-requirementsfrom
mbg/diagnostics/failed-sarif
Open

mbg wants to merge 14 commits into
mbg/reduce-config-requirementsfrom
mbg/diagnostics/failed-sarif

Conversation

@mbg

@mbg mbg commented Oct 9, 2026

Copy link
Copy Markdown
Member

Diagnostics are typically written to the database cluster and are then included in the SARIF that is generated by the CLI. However, in the CodeQL Action we may produce diagnostics before the database cluster is initialised. To work around this, we have so far relied on tracking diagnostics in memory that were created before the database cluster is ready. After the cluster is initialised, those diagnostics are then flushed to disk. However, this represents a problem if the database cluster is never successfully initialised.

This PR changes this so that diagnostics are written directly to a temporary directory on disk if the database cluster is not yet ready. They are then moved to the database cluster once it is initialised. If the cluster is never initialised, then we point the CLI at the temporary directory on disk using a --diagnostic-dir argument. The CLI will then pick up any diagnostics that are still in that location and include them in the failed SARIF.

Risk assessment

For internal use only. Please select the risk level of this change:

  • Low risk: Changes are fully under feature flags, or have been fully tested and validated in pre-production environments and are highly observable, or are documentation or test only.

Which use cases does this change impact?

Workflow types:

  • Advanced setup - Impacts users who have custom CodeQL workflows.
  • Managed - Impacts users with dynamic workflows (Default Setup, Code Quality, ...).

Products:

  • Code Scanning - The changes impact analyses when analysis-kinds: code-scanning.
  • Code Quality - The changes impact analyses when analysis-kinds: code-quality.
  • Other first-party - The changes impact other first-party analyses.

Environments:

  • Dotcom - Impacts CodeQL workflows on github.com and/or GitHub Enterprise Cloud with Data Residency.
  • GHES - Impacts CodeQL workflows on GitHub Enterprise Server.

How did/will you validate this change?

  • Unit tests - I am depending on unit test coverage (i.e. tests in .test.ts files).
  • End-to-end tests - I am depending on PR checks (i.e. tests in pr-checks).

If something goes wrong after this change is released, what are the mitigation and rollback strategies?

  • Rollback - Change can only be disabled by rolling back the release or releasing a new version with a fix.

How will you know if something goes wrong after this change is released?

  • Telemetry - I rely on existing telemetry or have made changes to the telemetry.
    • Dashboards - I will watch relevant dashboards for issues after the release. Consider whether this requires this change to be released at a particular time rather than as part of a regular release.
    • Alerts - New or existing monitors will trip if something goes wrong with this change.

Are there any special considerations for merging or releasing this change?

  • No special considerations - This change can be merged at any time.

Merge / deployment checklist

  • Confirm this change is backwards compatible with existing workflows.
  • Consider adding a changelog entry for this change.
  • Confirm the readme and docs have been updated if necessary.

@mbg
mbg changed the base branch from main to mbg/fs-abstraction October 9, 2026 22:30
@mbg
mbg added this pull request to stack #4224 October 9, 2026 22:30
@github-actions github-actions Bot added the size/L May be hard to review label Oct 9, 2026
@mbg
mbg force-pushed the mbg/diagnostics/failed-sarif branch 2 times, most recently from 520eff7 to 2613b9c Compare October 9, 2026 22:51
@github-actions github-actions Bot added size/XL May be very hard to review and removed size/L May be hard to review labels Oct 12, 2026
@mbg
mbg removed this pull request from stack #4224 October 12, 2026 11:00
@mbg
mbg force-pushed the mbg/diagnostics/failed-sarif branch from b5ce898 to 9312ede Compare October 12, 2026 11:54
@mbg
mbg changed the base branch from mbg/fs-abstraction to mbg/reduce-config-requirements October 12, 2026 11:54
@github-actions github-actions Bot added size/L May be hard to review and removed size/XL May be very hard to review labels Oct 12, 2026
@mbg
mbg force-pushed the mbg/diagnostics/failed-sarif branch from 9312ede to 65d8aa4 Compare October 12, 2026 12:02
@mbg
mbg force-pushed the mbg/diagnostics/failed-sarif branch from 65d8aa4 to 9eeab46 Compare October 12, 2026 13:23
@mbg
mbg marked this pull request as ready for review October 12, 2026 13:24
@mbg
mbg requested a review from a team as a code owner October 12, 2026 13:24
Copilot AI balanced review requested due to automatic review settings October 12, 2026 13:24

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Warning

  • Copilot's review of this pull request may be incomplete because some of the changed files are excluded by your Copilot content exclusion settings. See Excluding content from Copilot for details.

🟡 Changes recommended

Temporary-write failures can abort initialization, cross-filesystem moves can lose diagnostics, and the new check does not validate failed SARIF export.

5 open findings
What changed in this PR

Persists pre-database diagnostics on disk so they can be included in failed SARIF output.

Changes:

  • Replaces in-memory buffering with temporary diagnostic files.
  • Passes temporary diagnostics to CodeQL export.
  • Adds unit and PR-check coverage.
File Description
src/​diagnostics.ts Implements temporary persistence and database relocation.
src/​init-action.ts Flushes and logs temporary diagnostics.
src/​init-action-post-helper.ts Supplies temporary diagnostics during failed SARIF generation.
src/​codeql.ts Adds --diagnostic-dir support.
src/​diagnostics.test.ts Tests temporary persistence and flushing.
src/​setup-codeql.test.ts Provides temporary-directory test setup.
src/​config/​db-config.test.ts Provides temporary-directory test setup.
pr-checks/​diagnostics-without-db.ts Checks for the expected diagnostic file.
pr-checks/​checks/​diagnostics-without-db.yml Defines the new PR check.
lib/​entry-points.js Generated bundle; excluded from review.
.github/​workflows/​__diagnostics-without-db.yml Generated workflow; excluded from review.
Files excluded by content exclusion policy (2)
  • .github/workflows/__diagnostics-without-db.yml
  • lib/entry-points.js

🧠 Review effort: Balanced


💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.

Comment on lines +22 to +24
- name: Check diagnostics appear on disk
env:
SARIF_PATH: "${{ runner.temp }}/codeql-action-temp-diagnostics/"
Comment thread src/diagnostics.ts Outdated
Comment thread src/diagnostics.ts
Comment thread pr-checks/checks/diagnostics-without-db.yml Outdated
Comment thread src/diagnostics.ts Outdated
@mbg
mbg added this pull request to stack #4227 October 12, 2026 13:49
@mbg
mbg force-pushed the mbg/diagnostics/failed-sarif branch from 4b32487 to 9104ff3 Compare October 12, 2026 16:51
@github-actions github-actions Bot added size/XL May be very hard to review and removed size/L May be hard to review labels Oct 12, 2026

This branch has not been deployed

No deployments
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

size/XL May be very hard to review

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants